Saltar al contenido principal

API — Tenants — admin

Documentacao tecnica gerada automaticamente a partir da especificacao OpenAPI.


GET /api/tenants/current

Get Current Tenant Details

Exemplo resposta (200):

{
"id": 0,
"slug": "string",
"name": "string",
"business_name": null,
"domain": null,
"custom_domain": null,
"domain_type": null,
"domain_status": null,
"is_active": true,
"is_demo": true,
"config": null,
"trial_ends_at": null,
"stripe_customer_id": null,
"stripe_subscription_id": null,
"stripe_connect_account_id": null,
"subscription_status": "string",
"plan": "string",
"template_id": null,
"branding_primary_color": null,
"branding_secondary_color": null,
"branding_accent_color": null,
"branding_logo_url": null,
"branding_banner_url": null,
"branding_hero_url": null,
"branding_tagline": null,
"branding_about_text": null,
"branding_cta_text": null,
"branding_show_categories": true,
"branding_show_featured": true,
"branding_social_instagram": null,
"branding_social_facebook": null,
"branding_social_whatsapp": null,
"branding_social_tiktok": null,
"phone": null,
"email": null,
"city": null,
"address": null,
"website_url": null,
"business_type": null,
"timezone": null,
"default_currency": "string",
"default_language": "string",
"tax_included_in_prices": true,
"moloni_token": null,
"moloni_company_id": null,
"created_at": null,
"updated_at": null
}

PUT /api/tenants/current

Update Current Tenant

Corpo do pedido:

CampoTipoObrigatorioDescricao
nameobjectNaoName
business_nameobjectNaoBusiness Name
phoneobjectNaoPhone
emailobjectNaoEmail
cityobjectNaoCity
addressobjectNaoAddress
website_urlobjectNaoWebsite Url
business_typeobjectNaoBusiness Type
timezoneobjectNaoTimezone
default_currencyobjectNaoDefault Currency
default_languageobjectNaoDefault Language
tax_included_in_pricesobjectNaoTax Included In Prices
branding_primary_colorobjectNaoBranding Primary Color
branding_secondary_colorobjectNaoBranding Secondary Color
branding_accent_colorobjectNaoBranding Accent Color
branding_logo_urlobjectNaoBranding Logo Url
branding_banner_urlobjectNaoBranding Banner Url
branding_hero_urlobjectNaoBranding Hero Url
branding_taglineobjectNaoBranding Tagline
branding_about_textobjectNaoBranding About Text
branding_cta_textobjectNaoBranding Cta Text
branding_show_categoriesobjectNaoBranding Show Categories
branding_show_featuredobjectNaoBranding Show Featured
branding_social_instagramobjectNaoBranding Social Instagram
branding_social_facebookobjectNaoBranding Social Facebook
branding_social_whatsappobjectNaoBranding Social Whatsapp
branding_social_tiktokobjectNaoBranding Social Tiktok

Exemplo pedido:

{
"name": null,
"business_name": null,
"phone": null,
"email": null,
"city": null,
"address": null,
"website_url": null,
"business_type": null,
"timezone": null,
"default_currency": null,
"default_language": null,
"tax_included_in_prices": null,
"branding_primary_color": null,
"branding_secondary_color": null,
"branding_accent_color": null,
"branding_logo_url": null,
"branding_banner_url": null,
"branding_hero_url": null,
"branding_tagline": null,
"branding_about_text": null,
"branding_cta_text": null,
"branding_show_categories": null,
"branding_show_featured": null,
"branding_social_instagram": null,
"branding_social_facebook": null,
"branding_social_whatsapp": null,
"branding_social_tiktok": null
}

Exemplo resposta (200):

{
"id": 0,
"slug": "string",
"name": "string",
"business_name": null,
"domain": null,
"custom_domain": null,
"domain_type": null,
"domain_status": null,
"is_active": true,
"is_demo": true,
"config": null,
"trial_ends_at": null,
"stripe_customer_id": null,
"stripe_subscription_id": null,
"stripe_connect_account_id": null,
"subscription_status": "string",
"plan": "string",
"template_id": null,
"branding_primary_color": null,
"branding_secondary_color": null,
"branding_accent_color": null,
"branding_logo_url": null,
"branding_banner_url": null,
"branding_hero_url": null,
"branding_tagline": null,
"branding_about_text": null,
"branding_cta_text": null,
"branding_show_categories": true,
"branding_show_featured": true,
"branding_social_instagram": null,
"branding_social_facebook": null,
"branding_social_whatsapp": null,
"branding_social_tiktok": null,
"phone": null,
"email": null,
"city": null,
"address": null,
"website_url": null,
"business_type": null,
"timezone": null,
"default_currency": "string",
"default_language": "string",
"tax_included_in_prices": true,
"moloni_token": null,
"moloni_company_id": null,
"created_at": null,
"updated_at": null
}

Erros possiveis: 422 Validation Error


PUT /api/tenants/current/branding

Update Current Tenant Branding

Corpo do pedido:

CampoTipoObrigatorioDescricao
branding_primary_colorobjectNaoBranding Primary Color
branding_secondary_colorobjectNaoBranding Secondary Color
branding_accent_colorobjectNaoBranding Accent Color
branding_logo_urlobjectNaoBranding Logo Url
branding_banner_urlobjectNaoBranding Banner Url
branding_hero_urlobjectNaoBranding Hero Url
branding_taglineobjectNaoBranding Tagline
branding_about_textobjectNaoBranding About Text
branding_cta_textobjectNaoBranding Cta Text
branding_show_categoriesobjectNaoBranding Show Categories
branding_show_featuredobjectNaoBranding Show Featured
branding_social_instagramobjectNaoBranding Social Instagram
branding_social_facebookobjectNaoBranding Social Facebook
branding_social_whatsappobjectNaoBranding Social Whatsapp
branding_social_tiktokobjectNaoBranding Social Tiktok

Exemplo pedido:

{
"branding_primary_color": null,
"branding_secondary_color": null,
"branding_accent_color": null,
"branding_logo_url": null,
"branding_banner_url": null,
"branding_hero_url": null,
"branding_tagline": null,
"branding_about_text": null,
"branding_cta_text": null,
"branding_show_categories": null,
"branding_show_featured": null,
"branding_social_instagram": null,
"branding_social_facebook": null,
"branding_social_whatsapp": null,
"branding_social_tiktok": null
}

Exemplo resposta (200):

{
"id": 0,
"slug": "string",
"name": "string",
"business_name": null,
"domain": null,
"custom_domain": null,
"domain_type": null,
"domain_status": null,
"is_active": true,
"is_demo": true,
"config": null,
"trial_ends_at": null,
"stripe_customer_id": null,
"stripe_subscription_id": null,
"stripe_connect_account_id": null,
"subscription_status": "string",
"plan": "string",
"template_id": null,
"branding_primary_color": null,
"branding_secondary_color": null,
"branding_accent_color": null,
"branding_logo_url": null,
"branding_banner_url": null,
"branding_hero_url": null,
"branding_tagline": null,
"branding_about_text": null,
"branding_cta_text": null,
"branding_show_categories": true,
"branding_show_featured": true,
"branding_social_instagram": null,
"branding_social_facebook": null,
"branding_social_whatsapp": null,
"branding_social_tiktok": null,
"phone": null,
"email": null,
"city": null,
"address": null,
"website_url": null,
"business_type": null,
"timezone": null,
"default_currency": "string",
"default_language": "string",
"tax_included_in_prices": true,
"moloni_token": null,
"moloni_company_id": null,
"created_at": null,
"updated_at": null
}

Erros possiveis: 422 Validation Error


Documentacao gerada automaticamente.